Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Do not print logs if print command is used. #5728

Merged
merged 4 commits into from Jan 28, 2019
Merged

Do not print logs if print command is used. #5728

merged 4 commits into from Jan 28, 2019

Conversation

exoego
Copy link
Contributor

@exoego exoego commented Jan 20, 2019 •
edited

What did you implement:

Closes #5676

How did you implement it:

If print command is used, CLI#log become no-op.
Therefore logs are suppressed, except printing service definition.

Though duplicate-warnings are getting removed in #5733,
I think this change is worth to prevent similar "unexpected log while print" issues in future.

How can we verify it:

  1. npm install -g exoego/serverless#print-no-log
  2. Prepare the below yml.
service: 
  name: myservice
provider:
  name: aws
  runtime: nodejs8.10
functions:
  function1:
    handler: lib/proxy.handler
  function2:
    handler: lib/proxy.handler
  1. sls print, it should only give yml, no warnings.

Todos:

  • Write tests
  • Write documentation N/A
  • Fix linting errors
  • Make sure code coverage hasn't dropped
  • Provide verification config / commands / resources
  • Enable "Allow edits from maintainers" for this PR
  • Update the messages below

Is this ready for review?: YES
Is it a breaking change?: NO

@eahefnawy eahefnawy self-assigned this Jan 21, 2019
@eahefnawy eahefnawy self-requested a review January 21, 2019 15:16
eahefnawy
eahefnawy requested changes Jan 22, 2019
View reviewed changes
lib/Serverless.js Outdated
@@ -81,6 +81,7 @@ class Serverless {
if (this.cli.displayHelp(this.processedInput)) {
return BbPromise.resolve();
}
this.cli.suppressLog(this.processedInput);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you just add a comment here that explains that logs would only be suppressed if the print command is entered? Just to make it clear that logs don't always get suppressed, since all commands will run this method.

or maybe call the method suppressLogIfPrintCommand? 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed in 59c440e

eahefnawy
eahefnawy approved these changes Jan 28, 2019
View reviewed changes
Copy link
Member

@eahefnawy eahefnawy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beautiful! Thanks @exoego ❤️

@eahefnawy eahefnawy merged commit bdea48b into serverless:master Jan 28, 2019
@exoego exoego deleted the print-no-log branch January 28, 2019 11:20
@eahefnawy eahefnawy added this to the 1.36.4 milestone Jan 28, 2019
@shortjared shortjared added the bug label Feb 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eahefnawy eahefnawy eahefnawy approved these changes

Assignees

@eahefnawy eahefnawy

Labels
bug
Projects
None yet
Milestone
1.37.0
Development

Successfully merging this pull request may close these issues.

'sls print' contains Warnings.
4 participants
@exoego @eahefnawy @pmuens @shortjared